dxp-ux

[GET]

A customer bill is an electronic or paper document produced at the end of the billing process. The customer bill gathers and displays different items (applied customer billing rates generated during the rating and billing processes) to be charged to a customer.

List appliedCustomerBillingRate is used to retrieve all the items present in the bill other than Payment, Tax and Invoice types.

Billing account id and Bill id are mandatory in the request to retrieve the bill items.
Only Last 3 months bills are available in the BSS. Not found error will be present in the response, if the bill is not present in the BSS.

List appliedCustomerBillingRate

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/appliedCustomerBillingRate

URL PARAMS

Header

Query Param

Response [200]

[
    {
        "id": "8778779000000010",
        "date": "2022-12-20T00.00.000Z",
        "type": "SVC",
        "description": "SHOWTIME|THE MOVIE CHAN.",
        "characteristic": [
            {
                "name": "Reference",
                "value": "RP3S8 SRV"
            },
            {
                "name": "BalanceIndicator",
                "value": "I"
            }
        ],
        "taxExcludedAmount": {
            "unit": "USD",
            "value": 6.99
        },
        "@type": "AppliedCustomerBillingRate"
    },
    {
        "id": "8778779000000011",
        "date": "2022-12-20T00.00.000Z",
        "type": "PKG",
        "description": "ESPANOL HUB- 250/25MB",
        "characteristic": [
            {
                "name": "Reference",
                "value": "R3EIV PKG"
            },
            {
                "name": "BalanceIndicator",
                "value": "I"
            }
        ],
        "taxExcludedAmount": {
            "unit": "USD",
            "value": 85.99
        },
        "@type": "AppliedCustomerBillingRate"
    },
    {
        "id": "8778795000000010",
        "date": "2022-12-07T00.00.000Z",
        "type": "SCH",
        "description": "RECURR EFT RELEASED",
        "characteristic": [
            {
                "name": "Reference",
                "value": "RECP     "
            },
            {
                "name": "BalanceIndicator",
                "value": "E"
            }
        ],
        "taxExcludedAmount": {
            "unit": "USD",
            "value": 99.00
        },
        "@type": "AppliedCustomerBillingRate"
    }
]

Possible values of type

characteristic.BalanceIndicator
Indicates whether the amount of the detail is included or
excluded in the running balance. Valid values are as
follows:
E = Excluded from running balance
I = Included in running balance

Error Responses

For Invalid "billingAccount.id" 400

{
    "errors": [
        {
            "code": 400,
            "message": "INVALID:ACCOUNT ID",
            "description": "2099   ** CIP09W - UNABLE TO XREF SUB PREFIX"
        }
    ]
}

For missing "billingAccount.id" 400

{
    "errors": [
        {
            "code": 400,
            "message": "INVALID:ACCOUNT ID",
            "description": "-203   Invalid data sent in field: Key"
        }
    ]
}

For missing "bill.id" 404

{
    "errors": [
        {
            "code": 404,
            "message": "BILL ID NOT FOUND",
            "description": "bill.id not Found : , not found in the BillingAccount : 8211990010032423"
        }
    ]
}

For invalid "bill.id" 404

{
    "errors": [
        {
            "code": 404,
            "message": "BILL ID NOT FOUND",
            "description": "bill.id not Found : 77645H00004960, not found in the BillingAccount : 8211990010032423"
        }
    ]
}

For missing invalid channelId 400

{
    "errors": [
        {
            "code": 501,
            "message": "LLA:NOT_IMPLEMENTED",
            "description": "Operation GET for Business Id: PR and channelId:AP not implemented"
        }
    ]
}